.. _CScreenMultiPlayer Class: ========================== CScreenMultiPlayer Class ========================== .. toctree:: :maxdepth: 1 * :ref:`Overview` * :ref:`Quick Reference` * :ref:`Constructors` * :ref:`Methods` ---- .. _CScreenMultiPlayer_Overview: Overview --------------- .. note:: The **CScreenMultiPlayer** class handles multiplayer features ingame The structure used for this class is :ref:`CScreenMultiPlayer` ---- .. _CScreenMultiPlayer_QuickRef: Quick Reference --------------- +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Quick Ref** | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:CScreenMultiPlayer**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMultiPlayer\:\:~CScreenMultiPlayer**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMultiPlayer\:\:CancelEngine**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:CheckCharacterButtons**\(int nCharacterSlot, int\& bReadyActive, int\& bModifyPlayerActive, int\& bModifyCharacterActive) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:ClearChatMessages**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenMultiPlayer\:\:CheckMouseLButton**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenMultiPlayer\:\:CheckMouseMove**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenMultiPlayer\:\:CheckMouseRButton**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenMultiPlayer\:\:CheckSystemKeyCapsLock**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenMultiPlayer\:\:CheckSystemKeyCtrl**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenMultiPlayer\:\:CheckSystemKeyShift**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMultiPlayer\:\:EngineActivated**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMultiPlayer\:\:EngineDeactivated**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMultiPlayer\:\:EngineDestroyed**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMultiPlayer\:\:EngineGameInit**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMultiPlayer\:\:EngineGameUninit**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMultiPlayer\:\:EngineInitialized**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenMultiPlayer\:\:GetCapsLockKey**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMultiPlayer\:\:GetChatEditBoxStatus**\(:ref:`CString`\& sChatText, int\& bInputCapture) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenMultiPlayer\:\:GetEngineState**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual short **CScreenMultiPlayer\:\:GetNumVirtualKeys**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenMultiPlayer\:\:GetShiftKey**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual :ref:`CKeyInfo`\* **CScreenMultiPlayer\:\:GetVirtualKeys**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int\* **CScreenMultiPlayer\:\:GetVirtualKeysFlags**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:ImportFromSave**\(:ref:`CImportGame`\& game) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CScreenMultiPlayer\:\:IsMainDoneButtonClickable**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CScreenMultiPlayer\:\:IsModifyButtonClickable**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CScreenMultiPlayer\:\:IsPortraitButtonClickable**\(int nButton) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:KickPlayer**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:Logout**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:ModifyCharacters**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:OnCancelButtonClick**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:OnDoneButtonClick**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMultiPlayer\:\:OnKeyDown**\(int nKeysFlags) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:OnKickPlayerButtonClick**\(int nButton) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMultiPlayer\:\:OnLButtonDblClk**\(:ref:`CPoint` cPoint) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMultiPlayer\:\:OnLButtonDown**\(:ref:`CPoint` cPoint) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMultiPlayer\:\:OnLButtonUp**\(:ref:`CPoint` cPoint) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:OnLogoutButtonClick**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:OnMainDoneButtonClick**\(int selectedDifficulty) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:OnModifyButtonClick**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:OnModifyCharacterDelete**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMultiPlayer\:\:OnMouseMove**\(:ref:`CPoint` cPoint) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:OnPermissionButtonClick**\(int nPlayerSlot, int nPermissionType) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:OnPlayerSelection**\(int nPlayerSlot) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:OnPortraitButtonClick**\(int nButton) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMultiPlayer\:\:OnRButtonDown**\(:ref:`CPoint` cPoint) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMultiPlayer\:\:OnRButtonUp**\(:ref:`CPoint` cPoint) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:OnReadyButtonClick**\(int nButton) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMultiPlayer\:\:SetChatEditBoxStatus**\(:ref:`CString`\& sChatText, int bInputCapture) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:SetErrorState**\(int nErrorState) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:SetErrorText**\(unsigned long strErrorText) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:SetImportSetting**\(int nButton) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:SetMultiplayerScreenInformation**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMultiPlayer\:\:SetSystemKeyCapsLock**\(int bValue) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMultiPlayer\:\:SetSystemKeyCtrl**\(unsigned char bValue) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMultiPlayer\:\:SetSystemKeyShift**\(int bValue) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:StartMultiPlayer**\(int nEngineState) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMultiPlayer\:\:TimerAsynchronousUpdate**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenMultiPlayer\:\:TimerSynchronousUpdate**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:ToggleAllowReformParty**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:ToggleListenToJoin**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:UpdateLuaTables**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:UpdateMainPanel**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:UpdateMainPanelCharacter**\(int nCharacterSlot) | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenMultiPlayer\:\:UpdateModifyCharacterPanel**\() | +--------------------------------------------------------------------------------------------------------------------------------------------------------+ ---- .. _CScreenMultiPlayer_Constructors: Constructors --------------- +----------------------------------------------------------------------------------------+------------------------------------------------------+ | **Name** | **Description** | +----------------------------------------------------------------------------------------+------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:CScreenMultiPlayer` | Constructs a ``CScreenMultiPlayer`` object | +----------------------------------------------------------------------------------------+------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:CScreenMultiPlayer` | Destroys a ``CScreenMultiPlayer`` object | +----------------------------------------------------------------------------------------+------------------------------------------------------+ .. _CScreenMultiPlayerCScreenMultiPlayer: CScreenMultiPlayer\:\:CScreenMultiPlayer ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Constructs a ``CScreenMultiPlayer`` object :: void CScreenMultiPlayer::CScreenMultiPlayer(); **Remarks** Constructs a ``CScreenMultiPlayer`` object ---- .. _CScreenMultiPlayer~CScreenMultiPlayer: CScreenMultiPlayer\:\:~CScreenMultiPlayer ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Destroys the ``CScreenMultiPlayer`` object :: virtual void CScreenMultiPlayer::~CScreenMultiPlayer(); **Remarks** Destroys the ``CScreenMultiPlayer`` object ---- .. _CScreenMultiPlayer_Methods: Methods --------------- +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | **Name** | **Description** | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:CancelEngine` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:CheckCharacterButtons` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:ClearChatMessages` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:CheckMouseLButton` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:CheckMouseMove` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:CheckMouseRButton` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:CheckSystemKeyCapsLock` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:CheckSystemKeyCtrl` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:CheckSystemKeyShift` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:EngineActivated` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:EngineDeactivated` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:EngineDestroyed` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:EngineGameInit` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:EngineGameUninit` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:EngineInitialized` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:GetCapsLockKey` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:GetChatEditBoxStatus` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:GetEngineState` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:GetNumVirtualKeys` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:GetShiftKey` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:GetVirtualKeys` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:GetVirtualKeysFlags` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:ImportFromSave` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:IsMainDoneButtonClickable` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:IsModifyButtonClickable` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:IsPortraitButtonClickable` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:KickPlayer` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:Logout` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:ModifyCharacters` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:OnCancelButtonClick` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:OnDoneButtonClick` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:OnKeyDown` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:OnKickPlayerButtonClick` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:OnLButtonDblClk` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:OnLButtonDown` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:OnLButtonUp` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:OnLogoutButtonClick` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:OnMainDoneButtonClick` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:OnModifyButtonClick` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:OnModifyCharacterDelete` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:OnMouseMove` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:OnPermissionButtonClick` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:OnPlayerSelection` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:OnPortraitButtonClick` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:OnRButtonDown` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:OnRButtonUp` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:OnReadyButtonClick` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:SetChatEditBoxStatus` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:SetErrorState` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:SetErrorText` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:SetImportSetting` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:SetMultiplayerScreenInformation` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:SetSystemKeyCapsLock` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:SetSystemKeyCtrl` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:SetSystemKeyShift` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:StartMultiPlayer` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:TimerAsynchronousUpdate` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:TimerSynchronousUpdate` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:ToggleAllowReformParty` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:ToggleListenToJoin` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:UpdateLuaTables` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:UpdateMainPanel` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:UpdateMainPanelCharacter` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenMultiPlayer\:\:UpdateModifyCharacterPanel` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ ---- .. _CScreenMultiPlayerCancelEngine: CScreenMultiPlayer\:\:CancelEngine ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerCheckCharacterButtons: CScreenMultiPlayer\:\:CheckCharacterButtons ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerClearChatMessages: CScreenMultiPlayer\:\:ClearChatMessages ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerCheckMouseLButton: CScreenMultiPlayer\:\:CheckMouseLButton ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerCheckMouseMove: CScreenMultiPlayer\:\:CheckMouseMove ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerCheckMouseRButton: CScreenMultiPlayer\:\:CheckMouseRButton ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerCheckSystemKeyCapsLock: CScreenMultiPlayer\:\:CheckSystemKeyCapsLock ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerCheckSystemKeyCtrl: CScreenMultiPlayer\:\:CheckSystemKeyCtrl ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerCheckSystemKeyShift: CScreenMultiPlayer\:\:CheckSystemKeyShift ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerEngineActivated: CScreenMultiPlayer\:\:EngineActivated ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerEngineDeactivated: CScreenMultiPlayer\:\:EngineDeactivated ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerEngineDestroyed: CScreenMultiPlayer\:\:EngineDestroyed ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerEngineGameInit: CScreenMultiPlayer\:\:EngineGameInit ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerEngineGameUninit: CScreenMultiPlayer\:\:EngineGameUninit ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerEngineInitialized: CScreenMultiPlayer\:\:EngineInitialized ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerGetCapsLockKey: CScreenMultiPlayer\:\:GetCapsLockKey ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerGetChatEditBoxStatus: CScreenMultiPlayer\:\:GetChatEditBoxStatus ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerGetEngineState: CScreenMultiPlayer\:\:GetEngineState ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerGetNumVirtualKeys: CScreenMultiPlayer\:\:GetNumVirtualKeys ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerGetShiftKey: CScreenMultiPlayer\:\:GetShiftKey ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerGetVirtualKeys: CScreenMultiPlayer\:\:GetVirtualKeys ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerGetVirtualKeysFlags: CScreenMultiPlayer\:\:GetVirtualKeysFlags ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerImportFromSave: CScreenMultiPlayer\:\:ImportFromSave ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerIsMainDoneButtonClickable: CScreenMultiPlayer\:\:IsMainDoneButtonClickable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerIsModifyButtonClickable: CScreenMultiPlayer\:\:IsModifyButtonClickable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerIsPortraitButtonClickable: CScreenMultiPlayer\:\:IsPortraitButtonClickable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerKickPlayer: CScreenMultiPlayer\:\:KickPlayer ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerLogout: CScreenMultiPlayer\:\:Logout ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerModifyCharacters: CScreenMultiPlayer\:\:ModifyCharacters ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerOnCancelButtonClick: CScreenMultiPlayer\:\:OnCancelButtonClick ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerOnDoneButtonClick: CScreenMultiPlayer\:\:OnDoneButtonClick ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerOnKeyDown: CScreenMultiPlayer\:\:OnKeyDown ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerOnKickPlayerButtonClick: CScreenMultiPlayer\:\:OnKickPlayerButtonClick ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerOnLButtonDblClk: CScreenMultiPlayer\:\:OnLButtonDblClk ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerOnLButtonDown: CScreenMultiPlayer\:\:OnLButtonDown ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerOnLButtonUp: CScreenMultiPlayer\:\:OnLButtonUp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerOnLogoutButtonClick: CScreenMultiPlayer\:\:OnLogoutButtonClick ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerOnMainDoneButtonClick: CScreenMultiPlayer\:\:OnMainDoneButtonClick ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerOnModifyButtonClick: CScreenMultiPlayer\:\:OnModifyButtonClick ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerOnModifyCharacterDelete: CScreenMultiPlayer\:\:OnModifyCharacterDelete ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerOnMouseMove: CScreenMultiPlayer\:\:OnMouseMove ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerOnPermissionButtonClick: CScreenMultiPlayer\:\:OnPermissionButtonClick ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerOnPlayerSelection: CScreenMultiPlayer\:\:OnPlayerSelection ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerOnPortraitButtonClick: CScreenMultiPlayer\:\:OnPortraitButtonClick ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerOnRButtonDown: CScreenMultiPlayer\:\:OnRButtonDown ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerOnRButtonUp: CScreenMultiPlayer\:\:OnRButtonUp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerOnReadyButtonClick: CScreenMultiPlayer\:\:OnReadyButtonClick ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerSetChatEditBoxStatus: CScreenMultiPlayer\:\:SetChatEditBoxStatus ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerSetErrorState: CScreenMultiPlayer\:\:SetErrorState ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerSetErrorText: CScreenMultiPlayer\:\:SetErrorText ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerSetImportSetting: CScreenMultiPlayer\:\:SetImportSetting ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerSetMultiplayerScreenInformation: CScreenMultiPlayer\:\:SetMultiplayerScreenInformation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerSetSystemKeyCapsLock: CScreenMultiPlayer\:\:SetSystemKeyCapsLock ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerSetSystemKeyCtrl: CScreenMultiPlayer\:\:SetSystemKeyCtrl ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerSetSystemKeyShift: CScreenMultiPlayer\:\:SetSystemKeyShift ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerStartMultiPlayer: CScreenMultiPlayer\:\:StartMultiPlayer ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerTimerAsynchronousUpdate: CScreenMultiPlayer\:\:TimerAsynchronousUpdate ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerTimerSynchronousUpdate: CScreenMultiPlayer\:\:TimerSynchronousUpdate ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerToggleAllowReformParty: CScreenMultiPlayer\:\:ToggleAllowReformParty ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerToggleListenToJoin: CScreenMultiPlayer\:\:ToggleListenToJoin ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerUpdateLuaTables: CScreenMultiPlayer\:\:UpdateLuaTables ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerUpdateMainPanel: CScreenMultiPlayer\:\:UpdateMainPanel ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerUpdateMainPanelCharacter: CScreenMultiPlayer\:\:UpdateMainPanelCharacter ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CScreenMultiPlayerUpdateModifyCharacterPanel: CScreenMultiPlayer\:\:UpdateModifyCharacterPanel ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: x; **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks**